home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 1 / Atari Mega Archive - Volume 1.iso / gnu / othergnu / ispell.zoo / ispell4.doc < prev    next >
Text File  |  1990-04-19  |  8KB  |  212 lines
  1. ISPELL(4)         DOMAIN/IX Reference Manual ()         ISPELL(4)
  2.  
  3. NAME
  4.      ispell - format of ispell dictionaries
  5.  
  6. DESCRIPTION
  7.      Dictionaries for ispell(1) come in two formats: raw, and
  8.      unhashed.  The hashed dictionary is generated by buildhash
  9.      (see ispell(1)) from the raw dictionary, and is not
  10.      described here.
  11.  
  12.      A raw ispell dictionary (either the main dictionary or your
  13.      own personal dictionary) contains a list of words, one per
  14.      line.  Each word may optionally be followed by a slash ("/")
  15.      and one or more flags, which modify the root word as
  16.      explained below.  Case is significant in the root word, but
  17.      ignored in the flags.  The dictionary does not need to be
  18.      sorted.
  19.  
  20.      The case of the root word controls the case of words
  21.      accepted by ispell, as follows:
  22.  
  23.      (1)  If the root word appears only in lower case (e.g.,
  24.           "bob"), it will be accepted in lower case, capitalized,
  25.           or all capitals.
  26.  
  27.      (2)  If the root word appears capitalized (e.g., "Robert"),
  28.           it will be not be accepted in all-lower case, but will
  29.           be accepted capitalized or all in capitals.
  30.  
  31.      (3)  If the root word appears all in capitals (e.g.,
  32.           "UNIX"), it will only be accepted all in capitals.
  33.  
  34.      (4)  If the root word appears with a "funny" capitalization
  35.           (e.g., "ITCorp"), a word will be accepted only if it
  36.           follows that capitalization, or if it appears all in
  37.           capitals.
  38.  
  39.      (5)  More than one capitalization of a root word may appear
  40.           in the dictionary.  Flags from different capitaliza-
  41.           tions are combined by OR-ing them together.
  42.  
  43.      Redundant capitalizations (e.g., "bob" and "Bob") will be
  44.      combined by buildhash and by ispell (for personal dic-
  45.      tionaries), and can be removed from a raw dictionary by mun-
  46.      chlist.
  47.  
  48.      For example, the dictionary:
  49.  
  50.           bob
  51.           Robert
  52.           UNIX
  53.           ITcorp
  54.           ITCorp
  55.  
  56. Printed 7/7/87                                           ISPELL-1
  57.  
  58. ISPELL(4)         DOMAIN/IX Reference Manual ()         ISPELL(4)
  59.  
  60.      will accept "bob," "Bob," "BOB," "Robert," "ROBERT," "UNIX,"
  61.      "ITcorp," "ITCorp," and "ITCORP," and will reject all oth-
  62.      ers.  Some of the unacceptable forms are "bOb," "robert,"
  63.      "Unix," and "ItCorp."
  64.  
  65.      As mentioned above, root words in any dictionary may be
  66.      extended by flags.  Each flag is a single alphabetic charac-
  67.      ter, which represents a suffix that may be added to the root
  68.      to form a new word.  For example, the "D" flag can be added
  69.      to "bathe" to make "bathed".  Since flags are represented as
  70.      a single bit in the hashed dictionary, this results in sig-
  71.      nificant space savings.  The munchlist script will reduce an
  72.      existing raw dictionary by adding flags when possible.
  73.  
  74.      When a word is extended with a suffix, the suffix will be
  75.      accepted only if it appears in the same case as the final
  76.      letter of the word.  Thus, for example, the entry "UNIX/M"
  77.      in the main dictionary ("M" means add an apostrophe and an
  78.      "s" to make a possessive) would accept "UNIX'S" but would
  79.      reject "UNIX's".  If "UNIX's" is legal, it must appear as a
  80.      separate dictionary entry, and it will not be combined by
  81.      munchlist.
  82.  
  83.      In the following discussion of the flags, let # and @ be
  84.      "variables" that can stand for any letter.  Upper case
  85.      letters are constants.  "..." stands for any string of zero
  86.      or more letters, but note that no word may exist in the dic-
  87.      tionary which is not at least 2 letters long, so, for exam-
  88.      ple, "fly" may not be produced by placing the "Y" flag on
  89.      "f".  Also, no flag is effective unless the word that it
  90.      creates is at least 4 letters long, so, for example, "wed"
  91.      may not be produced by placing the "D" flag on "we".
  92.  
  93.      The meaning of the flags is as follows:
  94.  
  95.      V
  96.           ...e --> ...ive  as in create --> creative
  97.           if # .ne. e, ...# --> ...#ive  as in prevent -->
  98.                preventive
  99.  
  100.      N
  101.           ...e --> ...ion  as in create --> creation
  102.           ...y --> ...ication  as in multiply --> multiplication
  103.           if # .ne. e or y, ...# --> ...#en  as in fall --> fal-
  104.                len
  105.  
  106.      X
  107.           ...e --> ...ions  as in create --> creations
  108.           ...y --> ...ications  as in multiply --> multiplica-
  109.                tions
  110.           if # .ne. e or y, ...# --> ...#ens  as in weak -->
  111.                weakens
  112.  
  113. ISPELL-2                                           Printed 7/7/87
  114.  
  115. ISPELL(4)         DOMAIN/IX Reference Manual ()         ISPELL(4)
  116.  
  117.      H
  118.           ...y --> ...ieth  as in twenty --> twentieth
  119.           if # .ne. y, ...# --> ...#th  as in hundred --> hun-
  120.                dredth
  121.  
  122.      Y
  123.           ... --> ...ly  as in quick --> quickly
  124.  
  125.      G
  126.           ...e --> ...ing  as in file --> filing
  127.           if # .ne. e, ...# --> ...#ing  as in cross --> crossing
  128.  
  129.      J
  130.           ...e --> ...ings  as in file --> filings
  131.           if # .ne. e, ...# --> ...#ings  as in cross --> cross-
  132.                ings
  133.  
  134.      D
  135.           ...e --> ...ed  as in create --> created
  136.           if @ .ne. a, e, i, o, or u, ...@y --> ...@ied  as in
  137.                imply --> implied
  138.           if # .ne. e or y, or (# = y and @ = a, e, i, o, or u)
  139.                ...@# --> ...@#ed  as in cross --> crossed or con-
  140.                vey --> conveyed
  141.  
  142.      T
  143.           ...e --> ...est  as in late --> latest
  144.           if @ .ne. a, e, i, o, or u, ...@y --> ...@iest  as in
  145.                dirty --> dirtiest
  146.           if # .ne. e or y, or (# = y and @ = a, e, i, o, or u)
  147.                ...@# --> ...@#est  as in small --> smallest or
  148.                gray --> grayest
  149.  
  150.      R
  151.           ...e --> ...er  as in skate --> skater
  152.           if @ .ne. a, e, i, o, or u, ...@y --> ...@ier  as in
  153.                multiply --> multiplier
  154.           if # .ne. e or y, or (# = y and @ = a, e, i, o, or u)
  155.                ...@# --> ...@#er  as in build --> builder or con-
  156.                vey --> conveyer
  157.  
  158.      Z
  159.           ...e --> ...ers  as in skate --> skaters
  160.           if @ .ne. a, e, i, o, or u, ...@y --> ...@iers  as in
  161.                multiply --> multipliers
  162.           if # .ne. e or y, or (# = y and @ = a, e, i, o, or u)
  163.                ...@# --> ...@#ers  as in build --> builders or
  164.                slay --> slayers
  165.  
  166.      S
  167.           if @ .ne. a, e, i, o, or u, ...@y --> ...@ies  as in
  168.                imply --> implies
  169.  
  170. Printed 7/7/87                                           ISPELL-3
  171.  
  172. ISPELL(4)         DOMAIN/IX Reference Manual ()         ISPELL(4)
  173.  
  174.           if # .eq. s, x, z, or h, ...# --> ...#es  as in fix -->
  175.                fixes
  176.           if # .ne. s, x, z, h, or y, or (# = y and @ = a, e, i,
  177.                o, or u) ...@# --> ...@#s  as in bat --> bats or
  178.                convey --> conveys
  179.  
  180.      P
  181.           if @ .ne. a, e, i, o, or u, ...@y --> ...@iness  as in
  182.                cloudy --> cloudiness
  183.           if # .ne. y, or @ = a, e, i, o, or u, ...@# -->
  184.                ...@#ness  as in late --> lateness or gray -->
  185.                grayness
  186.  
  187.      M
  188.           ... --> ...'s  as in dog --> dog's
  189.  
  190.      To summarize more briefly:
  191.  
  192.           V - ive
  193.           N - ion, tion, en
  194.           X - ions, ications, ens
  195.           H - th, ieth
  196.           Y - ly
  197.           G - ing
  198.           J - ings
  199.           D - ed
  200.           T - est
  201.           R - er
  202.           Z - ers
  203.           S - s, es, ies
  204.           P - ness, iness
  205.           M - 's
  206.  
  207. SEE ALSO
  208.      ispell(1)
  209.  
  210. ISPELL-4                                           Printed 7/7/87
  211.  
  212.